Contributing guidelines #1074
Draft
Contributing guidelines #1074
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1074 +/- ##
=======================================
Coverage 50.55% 50.55%
=======================================
Files 63 63
Lines 2886 2886
=======================================
Hits 1459 1459
Misses 1427 1427
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
8 tasks
Mainly to store some guidelines about imports, in the attempt to refine them
alecandido
force-pushed
the
style-guidelines
branch
from
548d42e to
367f773
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is mostly saving a couple of comments:
However, the idea is not to replace existing guides and so on, but just to (discuss and) establish our own conventions, when there is a lack of "official" guidelines (e.g. PEP 8).
Maintaining docs is an expensive process, so replacing a custom guide with a reliable externally maintained one would be always welcome. In which case we could replace our content with external links (which would be still useful to collect somewhere).
But worse than writing some documents (and maintain them) is not having anything at all, and just having to repeat (or worse: discuss again) everything every time.
In any case, this is mainly a sketch, even to trigger comments about the need of it. Any comment is more than welcome.